Dokumentacja MAIL REST API 1.0

GET emails/<domain>/<name>

Opis
Odczyt ustawień wybranego konta pocztowego.
Sygnatura polecenia
  • Metoda żądania - GET
  • Ścieżka żądania (URL PATH) - parametry identyfikujące konto pocztowe
  • Ciało żądania - puste
  • Ciało odpowiedzi - wszystkie parametry opisujące konto pocztowe
Parametry ścieżki:
(string) domain
wymagany Nazwa domeny w obrębie której znajdują się konta pocztowe.
przykładowa wartość: demo.kei.pl
(string) name
wymagany Nazwa konta pocztowego, dla którego pobierane są informacje.
przykładowa wartość: postmaster
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - Pole musi mieć co najmniej 2 znaki / znaków
  • - Pole może mieć najwyżej 32 znaki / znaków
  • - Pole musi zawierać poprawną nazwę konta email (część adresu email do znaku @)
Parametry odpowiedzi:
email Pełen adres pocztowy
usage Aktualny stopień wykorzystania przyznanego limitu powierzchni wyrażony procentowo.
creation_date Data utworzenia konta pocztowego.
last_auth_date Data ostatniego logowania się do konta pocztowego.
last_auth_ip Adres IP ostatniego logowania się do konta pocztowego
(int) alias_limit Liczba aliasów pocztowych jakie może utworzyć właściciel konta pocztowego z poziomu panelu Webmail. Limit nie dotyczy operacji wykonywanych poprzez narzędzie WebAs.
(int) spam_rbl_default Aktywna wartość filtru antyspamowego rbl dla domeny. Obejmuje te konta pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
  • -1: domyślne (używanie ustawienia globalnego serwera)
  • 1: tak
  • 0: nie
(int) spam_spf_default Aktywna wartość filtru antyspamowego spf dla domeny. Obejmuje te konta pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
  • -1: domyślne (używanie ustawienia globalnego serwera)
  • 1: tak
  • 0: nie
(int) spam_greylist_default Aktywna wartość filtru antyspamowego greylist dla domeny. Obejmuje te konta pocztowe, które dla tego filtru mają ustawioną wartość domyślnie.
dopuszczalne wartości:
  • -1: domyślne (używanie ustawienia globalnego serwera)
  • 1: tak
  • 0: nie
description Opis konta jest dodatkową informacją dla użytkownika, która może ułatwić identyfikację konta.
(int) capacity Limit powierzchni dla konta pocztowego wyrażony w MB.
password Hasło powinno mieć od 6 do 15 znaków oraz zawierać przynajmniej jedną cyfrę lub jeden ze znaków specjalnych: ~ ! @ # % ^ & * ( ) _ + = - ; , . / < > ? : [ ] { }.
(int) usage_notification_level Wartość procentowa zajętosci skrzynki, przy której system będzie automatycznie powiadamiał o braku miejsca na pocztę. Takie powiadomienie jest generowane raz na 24h od momentu osiągnięcia wyznaczonego poziomu zajętości.
expiration_date Format daty to RRRR-mm-dd
(int) keep_mail Pozostawienie poczty na koncie po dostarczeniu.
(array) forwards Lista adresów, na które wiadomości będą przekierowane po dostarczeniu.
(int) forward_limit Limit adresów przekierowań, jakie może ustawić właściciel konta.
(array) aliases Lista aliasów pocztowych, wskazujących na konto pocztowe.
inbox_delete_after Liczba dni, po których nowe wiadomości będą automatycznie i bezpowrotnie usuwane ze skrzynki odbiorczej.
trash_delete_after Liczba dni, po których nowe wiadomości będą automatycznie i bezpowrotnie usuwane z kosza.
(int) spam_enabled Obsługa filtrów antyspamowych na koncie pocztowym.
spam_rule Akcja podjęta w przypadku uznania wiadomości za SPAM.
dopuszczalne wartości:
  • tag: Oznakowanie e-maila słowem SPAM
  • move: Przeniesienie e-maila do katalogu SPAM
(float) spam_hits Poziom wrażliwości filtrów antyspamowych. Niższa czułość to łagodniejsze działanie filtrów i oznacza, iż wiadomość pocztowa musi spełnić więcej kryteriów żeby zostać uznana za SPAM. Skutkuje to mniejszą liczbą wiadomości oznaczonych jako SPAM.
dopuszczalne wartości:
  • 2: duża
  • 5: normalna
  • 7: mała
  • 9: bardzo mała
(int) spam_delete_after Liczba dni, po upływie których poczta uznana za SPAM zostanie usunięta z przeznaczonego na nią folderu. Wartość 0 wyłącza automat czyszczący dla skrzynki.
(array) spam_white_list Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez system pocztowy.
(array) spam_black_list Adresy e-mail lub domeny, które nigdy nie zostaną zaakceptowane przez system pocztowy.
(array) spam_greylist_whitelist Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm Greylist.
(array) spam_spf_whitelist Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm SPF.
(array) spam_rbl_whitelist Adresy e-mail lub domeny, które zawsze zostaną zaakceptowane przez mechanizm RBL.
(int) spam_rbl_enabled Mechanizm RBL (Real-time Blackhole List ) stale monitoruje i zbiera adresy IP serwerów, które są odpowiedzialne za rozsyłanie spamu do użytkowników poczty. Włączenie opcji pozwala zmniejszyć liczbę spamu.
dopuszczalne wartości:
  • -1: domyślne
  • 1: tak
  • 0: nie
(int) spam_spf_enabled Mechanizm SPF zabezpiecza serwery SMTP przed przyjmowaniem poczty z niedozwolonych źródeł. Włączenie opcji pozwala ograniczyć wysyłanie wiadomości przez spamerów podszywających się pod cudze adresy e-mail.
dopuszczalne wartości:
  • -1: domyślne
  • 1: tak
  • 0: nie
(int) spam_greylist_enabled Mechanizm GREYLIST odrzuca maile od nierozpoznanych nadawców przy pierwszej próbie ich dostarczenia, natomiast akceptuje je przy drugiej. Jeśli poczta pochodzi z serwera rozsyłającego spam, na ogół nie jest wysyłana ponownie.
dopuszczalne wartości:
  • -1: domyślne
  • 1: tak
  • 0: nie
sms_phone_number_1 np. 500123456 lub jankowalski@kei.pl
sms_login_1 Nazwa użytkownika, która ma zostać użyta podczas logowania do bramki SMS operatora.
sms_password_1 Hasło użytkownika, która ma zostać użyta podczas logowania do bramki SMS operatora.
(int) sms_operator_1 Oznaczenie operatora sieci GSM dla pierwszego numeru telefonu.
dopuszczalne wartości:
  • 0: Autodetekcja
  • 11: Plus GSM
  • 12: Simplus
  • 13: Sami Swoi
  • 21: T-Mobile
  • 22: Tak-Tak
  • 23: Heyah
  • 31: Orange
  • 32: Orange Go
  • 33: POP
  • 51: PLAY
sms_phone_number_2 np. 500123456 lub jankowalski@kei.pl.
sms_login_2 Nazwa użytkownika, która ma zostać użyta podczas logowania do bramki SMS operatora.
sms_password_2 Hasło użytkownika, która ma zostać użyta podczas logowania do bramki SMS operatora.
(int) sms_operator_2 Oznaczenie operatora sieci GSM dla drugiego numeru telefonu.
dopuszczalne wartości:
  • 0: Autodetekcja
  • 11: Plus GSM
  • 12: Simplus
  • 13: Sami Swoi
  • 21: T-Mobile
  • 22: Tak-Tak
  • 23: Heyah
  • 31: Orange
  • 32: Orange Go
  • 33: POP
  • 51: PLAY
(int) sms_send_to Sposób w jaki automat będzie się komunikował z bramką SMS.
dopuszczalne wartości:
  • 0: Bramkę operatora
  • 1: Konto pocztowe u operatora
(int) sms_cnt Wybór treści jakie mają trafiać do powiadomienia SMS oraz ich liczba.
dopuszczalne wartości:
  • 0: 1:SMS tylko tytuł maila
  • 1: 1:SMS tytuł i treść maila
  • 2: 2:SMS tytuł i treść maila
  • 3: 3:SMS tytuł i treść maila
(int) autoresponder_mode Wybór czy dla skrzynki ma być włączona usługa autoodpowiedzi. Działanie może mieć charakter okresowowy lub permanentny.
dopuszczalne wartości:
  • 0: Wyłączona
  • 1: Włączona
autoresponder_start_date Data od kiedy usługa autoodpowiedzi będzie aktywna w formacie RRRR-MM-DD.
autoresponder_end_date Data do kiedy usługa autoodpowiedzi ma być aktywna w formacie RRRR-MM-DD.
autoresponder_body Treść wiadomości wysyłanej do nadawcy przez usługę autoodpowiedzi.
(int) blocked Flaga administracyjnej blokady konta pocztowego.
Przykładowe zapytanie:
GET https://as27.demo.kei.pl/v1/emails/demo.kei.pl/postmaster
Przykładowa odpowiedź:
{
    "name":"postmaster",
    "domain":"demo.kei.pl",
    "email":"postmaster@demo.kei.pl",
    "description":"opis",
    "capacity":3,
    "usage":5,
    "password":"",
    "password_retype":"",
    "usage_notification_level":0,
    "expiration_date":"",
    "creation_date":"",
    "last_auth_date":"2014-02-13",
    "last_auth_ip":"imap",
    "keep_mail":1,
    "forward_email_1":"abc@abc.pl",
    "forward_email_2":"def@wp.pl",
    "forward_email_3":"ghi@pl",
    "forwards":[
        "abc@abc.pl",
        "def@wp.pl",
        "ghi@pl",
    ],
    "forward_limit":25,
    "aliases":[

    ],
    "alias_limit":12,
    "alias_creation_priv":0,
    "inbox_delete_after":0,
    "trash_delete_after":0,
    "spam_enabled":0,
    "spam_rule":"tag",
    "spam_hits":5,
    "spam_delete_after":0,
    "spam_white_list":[

    ],
    "spam_black_list":[

    ],
    "spam_greylist_whitelist":[

    ],
    "spam_spf_whitelist":[

    ],
    "spam_rbl_whitelist":[

    ],
    "spam_rbl_enabled":-1,
    "spam_spf_enabled":-1,
    "spam_greylist_enabled":-1,
    "spam_rbl_default":1,
    "spam_spf_default":1,
    "spam_greylist_default":0,
    "sms_phone_number_1":"",
    "sms_login_1":"",
    "sms_password_1":"",
    "sms_operator_1":0,
    "sms_phone_number_2":"",
    "sms_login_2":"",
    "sms_password_2":"",
    "sms_operator_2":0,
    "sms_send_to":0,
    "sms_cnt":0,
    "autoresponder_mode":0,
    "autoresponder_start_date":"",
    "autoresponder_end_date":"",
    "autoresponder_body":"",
    "blocked":0,
    "extra_rules":0
}